Platform Explorer / Nuxeo Platform 2023.9

Component org.nuxeo.ecm.platform.admin.center.actions.widgets

Documentation

@since 6.0, global widgets used to render actions/tabs in Admin Center.

Resolution Order

33
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Contributions

XML Source

<component name="org.nuxeo.ecm.platform.admin.center.actions.widgets">

  <documentation>
    @since 6.0, global widgets used to render actions/tabs
    in Admin Center.
  </documentation>

  <extension target="org.nuxeo.ecm.platform.forms.layout.WebLayoutManager"
    point="widgets">

    <widget name="adminCenterTabs" type="tabs">
      <properties mode="view">
        <property name="actionsDisplay">links</property>
        <property name="addForm">true</property>
        <property name="useAjaxForm">#{useAjaxTabs}</property>
        <property name="category">NUXEO_ADMIN</property>
        <property name="actions">#{adminViews.availableActions}</property>
        <property name="currentTabAction">#{adminViews.currentView}</property>
        <property name="overallDisplay">vertical_block</property>
        <property name="tabContentBeforeInclude">/incl/appcenter/admin_tab_header.xhtml</property>
      </properties>
    </widget>

    <widget name="adminCenterSubTabs" type="tabs">
      <properties mode="view">
        <property name="actionsDisplay">links</property>
        <property name="addForm">true</property>
        <!-- use ajax only if bookmarkable URLs can be preserved -->
        <property name="useAjaxForm">#{canUseAjaxTabs}</property>
        <property name="actions">#{adminViews.availableSubActions}</property>
        <property name="currentTabAction">#{adminViews.currentSubView}</property>
      </properties>
    </widget>

  </extension>

  <extension target="org.nuxeo.ecm.platform.forms.layout.LayoutStore"
    point="widgettypes">

    <widgetType name="admin_rest_document_link">
      <categories>
        <category>jsfAction</category>
      </categories>
      <configuration>
        <sinceVersion>6.0</sinceVersion>
        <title>Document Admin Rest Link</title>
        <description>
          Widget displaying a restful document link for an action
          (typically a tab link). Useful for Admin Center tabs migration to tabs
          widget, to apply compatibility changes on existing actions.
        </description>
        <categories>
          <category>action</category>
        </categories>
        <supportedModes>
          <mode>view</mode>
        </supportedModes>
        <properties>
          <defaultValues mode="any">
            <property name="repositoryName">#{currentServerLocation.name}</property>
            <property name="discardSurroundingForm">true</property>
            <property name="disableMultiPartForm">true</property>
            <property name="supportAjax">#{canUseAjaxTabs}</property>
            <property name="view">view_admin</property>
            <property name="pattern">admin</property>
          </defaultValues>
          <layouts mode="view">
            <layout name="rest_document_link_action_widget_type_properties_view">
              <rows>
                <row>
                  <widget category="actionWidgetTypeConf">label</widget>
                </row>
                <row>
                  <widget category="actionWidgetTypeConf">icon</widget>
                </row>
                <row>
                  <widget category="actionWidgetTypeConf">ajaxSupport</widget>
                </row>
                <row>
                  <widget category="actionWidgetTypeConf">onclick</widget>
                </row>
                <row>
                  <widget category="actionWidgetTypeConf">target</widget>
                </row>
                <row>
                  <widget category="actionWidgetTypeConf">confirm</widget>
                </row>
                <row>
                  <widget category="actionWidgetTypeConf">confirmMessage</widget>
                </row>
                <row>
                  <widget category="actionWidgetTypeConf">confirmMessageArgs</widget>
                </row>
                <row>
                  <widget category="actionWidgetTypeConf">rest_document_link_view</widget>
                </row>
              </rows>
            </layout>
          </layouts>
        </properties>
      </configuration>
      <handler-class>
        org.nuxeo.ecm.platform.actions.facelets.ActionWidgetTypeHandler
      </handler-class>
      <property name="template">
        /incl/action/widgets/rest_document_link_action_template.xhtml
      </property>
      <property name="compat_template">
        /incl/action/rest_document_link_action_template.xhtml
      </property>
      <property name="dev_template">
        /widgets/actions/dev/action_widget_type_dev_template.xhtml
      </property>
    </widgetType>

  </extension>

  <extension target="org.nuxeo.ecm.platform.actions.ActionService"
    point="typeCompatibility">

    <typeCompatibility type="admin_rest_document_link">
      <category>NUXEO_ADMIN</category>
      <category>SystemInfo_sub_tab</category>
      <category>UsersActivity_sub_tab</category>
      <category>ConnectClient_sub_tab</category>
      <category>ConnectApps_sub_tab</category>
      <category>UsersGroupsManager_sub_tab</category>
      <category>Monitoring_sub_tab</category>
      <category>DashboardManagement_sub_tab</category>
      <category>OAuthOpensocial_sub_tab</category>
      <category>ElasticSearch_sub_tab</category>
    </typeCompatibility>

  </extension>

</component>